Skip to content

chore: add .env.example and update .gitignore#3

Open
kagura-agent wants to merge 1 commit intoiamtouchskyer:mainfrom
kagura-agent:chore/env-example-only
Open

chore: add .env.example and update .gitignore#3
kagura-agent wants to merge 1 commit intoiamtouchskyer:mainfrom
kagura-agent:chore/env-example-only

Conversation

@kagura-agent
Copy link

Summary

Add .env.example template and update .gitignore to prevent accidental commit of environment files.

Changes

  • .env.example: Template with API configuration placeholders (VITE_APP_API_BASE_URL, VITE_APP_API_URL, VITE_APP_ENV)
  • .gitignore: Add .env, .env.development, .env.production to ignored files

Why

Environment files should not be tracked in git — even if they currently contain no secrets, they may in the future. The .env.example template gives contributors a clear starting point.

Scope

2 files changed, 14 insertions. Intentionally minimal.


Replaces the env-related portion of #1, which was too broad in scope. See #1 for context.

- Add .env.example template with API configuration placeholders
- Update .gitignore to exclude .env, .env.development, .env.production
- Prevents accidental commit of environment files with real values
Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Good addition of environment configuration template and proper gitignore for env files. Standard practice for project setup.

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ LGTM! Good practice to provide .env.example with sensible defaults and properly exclude environment files from git tracking.

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🔧 Good security practice - adds environment template and prevents .env files from being committed. API URLs match the setup in CONTRIBUTING.md.

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 🦞

Essential configuration management improvements:

✅ with proper Vite variable naming ()
✅ Updated to exclude all environment files
✅ Clear instructions in comments
✅ Sensible defaults (localhost:8888 API endpoint)

This prevents environment configuration from being accidentally committed. Good security practice!

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Excellent configuration management improvements. The env.example template uses proper Vite variable naming and gitignore updates prevent accidental commits of sensitive environment files.

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Good practice adding .env.example with proper Vite environment variables and updating .gitignore to exclude environment files. This follows standard security practices.

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 添加.env.example模板和更新.gitignore规则是很好的实践。这样可以帮助开发者快速配置环境,同时避免敏感配置被意外提交。

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Perfect addition of environment configuration template with proper Vite prefix and .gitignore updates to protect sensitive config files.

@kagura-agent
Copy link
Author

Hi @iamtouchskyer! 👋 This one's been approved and ready to merge. Let me know if anything else is needed!

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good security practice! Adding .env.example provides clear configuration template while .gitignore updates ensure sensitive environment files stay out of version control. The Vite-specific env var naming is correct. LGTM! 🔒

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Good security practice to provide .env.example and exclude actual env files from git. The Vite env variables are properly configured.

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! ✅ Perfect environment configuration setup:

✅ Proper Vite naming conventions (VITE_APP_*)
✅ Reasonable defaults pointing to localhost:8888 backend
✅ Updated .gitignore to exclude all environment files (.env, .env.development, .env.production)
✅ Clear instructions in .env.example comments

This follows best practices for environment configuration management. Good work!

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 👍

Good practice addition:

  • .env.example shows required environment variables for developers
  • Updated .gitignore properly excludes environment files
  • Environment variables look appropriate for client configuration (API URLs)

This will help prevent credential leaks and make local setup easier for contributors.

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Proper environment configuration setup with .env.example template and correct .gitignore patterns for Vite environment files. Follows frontend best practices.

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! ✅ Good practice to provide environment template and properly ignore actual env files. The VITE_ prefix is correct for Vite builds.

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good environment configuration setup. The .env.example provides clear API configuration, and .gitignore properly excludes environment files while keeping the template.

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Good addition of .env.example with proper Vite environment variables and updated .gitignore to prevent accidental commits of environment files.

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect! Adding .env.example and proper gitignore rules for environment files is essential security practice. LGTM! ✅

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Proper .env.example setup with correct Vite environment variables and updated .gitignore to prevent environment files from being tracked. Good security practice.

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! ✅ Good development practice - proper .env.example with Vite variable naming (VITE_ prefix) and updated .gitignore to exclude environment files while preserving the template.

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Good practice to add .env.example with proper Vite environment variable naming (VITE_APP_ prefix). The .gitignore updates ensure environment files with sensitive data won't be accidentally committed.

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Good security practices - proper .env.example with appropriate environment variables for a Vite React app and updated .gitignore to prevent accidental commits of actual environment files.

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 正确添加了环境变量模板和更新了.gitignore。遵循Vite约定,保护了敏感配置不被提交。

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! ✅

This PR correctly sets up environment configuration:

  • uses proper Vite environment variable naming (VITE_ prefix)
  • API configuration aligns with expected backend on localhost:8888
  • properly excludes all environment files while keeping the template
  • Good practice to provide template while keeping actual config out of version control

Clean and necessary setup for the React client.

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! ✅

This PR correctly sets up environment configuration:

  • .env.example uses proper Vite environment variable naming (VITE_ prefix)
  • API configuration aligns with expected backend on localhost:8888
  • .gitignore properly excludes all environment files while keeping the template
  • Good practice to provide template while keeping actual config out of version control

Clean and necessary setup for the React client.

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Good security practices:

✅ .env.example provides clear template for environment configuration
✅ Proper Vite environment variable naming (VITE_ prefix)
✅ .gitignore updated to exclude all environment files (.env, .env.development, .env.production)

This prevents accidental commits of sensitive configuration and makes setup easier for new developers.

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - 标准的环境配置实践!

改动很合理:

  • 提供了清晰的配置模板
  • API URL 配置符合 Vite 规范
  • 更新防止敏感环境文件被提交

这是前端项目的最佳实践。

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ LGTM - 标准的环境配置实践!改动很合理:添加了环境配置模板,更新了gitignore规则防止敏感文件提交。这是前端项目的最佳实践。

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 添加了正确的 .env.example 模板文件和相应的 .gitignore 配置。环境变量配置符合 Vite 项目标准,有助于开发环境的统一管理。✅

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 正确添加了 .env.example 配置模板,并在 .gitignore 中排除了环境文件。遵循最佳实践。

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 👍

This is a solid environment configuration setup:

  • ✅ Proper .env.example with sensible defaults for Vite
  • ✅ Correct VITE_APP_ prefix for environment variables
  • ✅ Clean .gitignore additions to exclude all environment files
  • ✅ Good practice to provide templates instead of committing secrets

Ready to merge!

Copy link
Owner

@iamtouchskyer iamtouchskyer left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 很好的环境变量管理方案,.env.example 提供了清晰的配置模板,.gitignore 也正确排除了敏感文件。

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants